<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN">
<html>
<head>
<title>Sort Hint Element (Eclipse BIRT ROM Documentation)</title>
<link rel="stylesheet" href="../style/style.css" type="text/css"/>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
<p class="title">Eclipse BIRT Report Object Model (ROM)</p>
<p class="subtitle">SortHint Structure</p>
<h1>Structure Overview</h1>
<div class="section-text">
Supports row ordering.</div>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Display Name:</td>
<td>Sort Hint</td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
</table>

<h3>Property Summary</h3>

<dl class="section-text">
<dt><a href="#Property-columnName">columnName</a></dt>
<dd>Name of the result set column for which hints are defined.</dd>
<dt><a href="#Property-direction">direction</a></dt>
<dd>The sort direction of this result set column.</dd>
<dt><a href="#Property-isOptional">isOptional</a></dt>
<dd>Indicates whether this sort key can be excluded at runtime.</dd>
<dt><a href="#Property-nullValueOrdering">nullValueOrdering</a></dt>
<dd>The ordering of null vs. non-null values in the sort order.</dd>
<dt><a href="#Property-position">position</a></dt>
<dd>The 1-based index position of a result set column.</dd>
</dl>

<h3>Description</h3>

<div class="section-text">
<p>Supports row ordering. Its properties can be mapped to ODA corresponding values.</p></div>
<h1>Property Detail</h1>

<h2><a name="Property-columnName">columnName Property</a></h2>

<p class="section-text">Name of the result set column for which hints are defined.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#string">string</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Column Name</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Name of the result set column for which hints are defined. If a column can only be identified by position, the name may be empty.</p></div>

<hr>
<h2><a name="Property-direction">direction Property</a></h2>

<p class="section-text">The sort direction of this result set column.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (sortDirection)</td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Sort Direction</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>asc</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>asc</td>
<td>Ascending</td>
<td>asc</td>
<td>the direction of sort hint is ascending.</td></tr>
<tr><td>desc</td>
<td>Descending</td>
<td>desc</td>
<td>the direction of sort hint is descending.</td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>The sort direction of this result set column.</p></div>

<hr>
<h2><a name="Property-isOptional">isOptional Property</a></h2>

<p class="section-text">Indicates whether this sort key can be excluded at runtime.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#boolean">boolean</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Optional</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>false</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>Indicates whether this sort key can be excluded at runtime.</p></div>

<hr>
<h2><a name="Property-nullValueOrdering">nullValueOrdering Property</a></h2>

<p class="section-text">The ordering of null vs. non-null values in the sort order.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#choice">choice</a> (nullValueOrderingType)</td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Null Value Ordering</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>unknown</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Choices</h3>

<table class="section-table">
<thead><tr><td>Name</td><td>Display Name</td>
<td>Value</td><td>Description</td></tr></thead>
<tbody>
<tr><td>unknown</td>
<td>Unknown</td>
<td>unknown</td>
<td>the ordering of null in the sort order is unknown.</td></tr>
<tr><td>nullIsFirst</td>
<td>NullIsFirst</td>
<td>nullIsFirst</td>
<td>the ordering of null in the sort order is first.</td></tr>
<tr><td>nullIsLast</td>
<td>NullIsLast</td>
<td>nullIsLast</td>
<td>the ordering of null in the sort order is last.</td></tr>
</tbody></table><br>
<h3>Description</h3>

<div class="section-text">
<p>The ordering of null vs. non-null values in the sort order.</p></div>

<hr>
<h2><a name="Property-position">position Property</a></h2>

<p class="section-text">The 1-based index position of a result set column.</p>
<h3>Details</h3>

<table class="detail-table">
<tr><td>Type:</td>
<td><a href="../types.html#integer">integer</a></td></tr>
<tr><td>Since:</td>
<td>2.5</td></tr>
<tr><td>Required:</td>
<td>No</td></tr>
<tr><td>Display Name:</td>
<td>Column Position</td></tr>
<tr><td>JavaScript Type:</td>
<td></td></tr>
<tr><td>Default Value:</td>
<td>None</td></tr>
<tr><td>Runtime Settable:</td>
<td>Yes</td></tr>
</table>

<h3>Description</h3>

<div class="section-text">
<p>The 1-based index position of a result set column.</p></div>
</body>
</html>
